home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3n / t_getinfo.z / t_getinfo
Encoding:
Text File  |  2002-10-03  |  13.8 KB  |  199 lines
  1.  
  2.  
  3.  
  4. tttt____ggggeeeettttiiiinnnnffffoooo((((3333NNNN))))                                                    tttt____ggggeeeettttiiiinnnnffffoooo((((3333NNNN))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _tttt______gggg_eeee_tttt_iiii_nnnn_ffff_oooo - get protocol-specific service information
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_ffff_dddd_eeee_ffff ______XXXX_OOOO_PPPP_EEEE_NNNN______SSSS_OOOO_UUUU_RRRR_CCCC_EEEE
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_xxxx_tttt_iiii_...._hhhh_>>>>
  14.      _####_eeee_llll_ssss_eeee
  15.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_tttt_iiii_uuuu_ssss_eeee_rrrr_...._hhhh_>>>>
  16.      _####_eeee_nnnn_dddd_iiii_ffff
  17.  
  18.      _iiii_nnnn_tttt _tttt______gggg_eeee_tttt_iiii_nnnn_ffff_oooo_((((_ffff_dddd_,,,, _iiii_nnnn_ffff_oooo_))))
  19.      _iiii_nnnn_tttt _ffff_dddd_;;;;
  20.      _ssss_tttt_rrrr_uuuu_cccc_tttt _tttt______iiii_nnnn_ffff_oooo _****_iiii_nnnn_ffff_oooo_;;;;
  21.  
  22. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  23.      This function returns the current characteristics of the underlying
  24.      transport protocol associated with file descriptor _ffff_dddd.  The _iiii_nnnn_ffff_oooo
  25.      structure is used to return the same information returned by _tttt______oooo_pppp_eeee_nnnn.
  26.      This function enables a transport user to access this information during
  27.      any phase of communication.
  28.  
  29.      This argument points to a _tttt______iiii_nnnn_ffff_oooo structure, which contains the following
  30.      members:
  31.  
  32.      _llll_oooo_nnnn_gggg _aaaa_dddd_dddd_rrrr_;;;;/* max size of the transport protocol address */
  33.      _llll_oooo_nnnn_gggg _oooo_pppp_tttt_iiii_oooo_nnnn_ssss_;;;;/* max number of bytes of protocol-specific options */
  34.      _llll_oooo_nnnn_gggg _tttt_ssss_dddd_uuuu_;;;;/* max size of a transport service data unit (_TTTT_SSSS_DDDD_UUUU) */
  35.      _llll_oooo_nnnn_gggg _eeee_tttt_ssss_dddd_uuuu_;;;;/* max size of an expedited transport service data unit (_EEEE_TTTT_SSSS_DDDD_UUUU) */
  36.      _llll_oooo_nnnn_gggg _cccc_oooo_nnnn_nnnn_eeee_cccc_tttt_;;;;/* max amount of data allowed on connection establishment functions */
  37.      _llll_oooo_nnnn_gggg _dddd_iiii_ssss_cccc_oooo_nnnn_;;;;/* max amount of data allowed on _tttt______ssss_nnnn_dddd_dddd_iiii_ssss and _tttt______rrrr_cccc_vvvv_dddd_iiii_ssss functions */
  38.      _llll_oooo_nnnn_gggg _ssss_eeee_rrrr_vvvv_tttt_yyyy_pppp_eeee_;;;;/* service type supported by the transport provider */
  39.  
  40.      _####_iiii_ffff_dddd_eeee_ffff ______XXXX_OOOO_PPPP_EEEE_NNNN______SSSS_OOOO_UUUU_RRRR_CCCC_EEEE
  41.      _llll_oooo_nnnn_gggg _ffff_llll_aaaa_gggg_ssss_;;;;/* other info about the transport provider */
  42.      _####_eeee_nnnn_dddd_iiii_ffff
  43.  
  44.      The values of the fields have the following meanings:
  45.  
  46.      _aaaa_dddd_dddd_rrrr          A value greater than or equal to zero indicates the maximum
  47.                    size of a transport protocol address; a value of -1
  48.                    specifies that there is no limit on the address size; and a
  49.                    value of -2 specifies that the transport provider does not
  50.                    provide user access to transport protocol addresses.
  51.  
  52.      _oooo_pppp_tttt_iiii_oooo_nnnn_ssss       A value greater than or equal to zero indicates the maximum
  53.                    number of bytes of protocol-specific options supported by
  54.                    the provider; a value of -1 specifies that there is no
  55.                    limit on the option size; and a value of -2 specifies that
  56.                    the transport provider does not support user-settable
  57.                    options.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. tttt____ggggeeeettttiiiinnnnffffoooo((((3333NNNN))))                                                    tttt____ggggeeeettttiiiinnnnffffoooo((((3333NNNN))))
  71.  
  72.  
  73.  
  74.      _tttt_ssss_dddd_uuuu          A value greater than zero specifies the maximum size of a
  75.                    transport service data unit (_TTTT_SSSS_DDDD_UUUU); a value of zero
  76.                    specifies that the transport provider does not support the
  77.                    concept of _TTTT_SSSS_DDDD_UUUU, although it does support the sending of a
  78.                    data stream with no logical boundaries preserved across a
  79.                    connection; a value of -1 specifies that there is no limit
  80.                    on the size of a _TTTT_SSSS_DDDD_UUUU; and a value of -2 specifies that the
  81.                    transfer of normal data is not supported by the transport
  82.                    provider.
  83.  
  84.      _eeee_tttt_ssss_dddd_uuuu         A value greater than zero specifies the maximum size of an
  85.                    expedited transport service data unit (_EEEE_TTTT_SSSS_DDDD_UUUU); a value of
  86.                    zero specifies that the transport provider does not support
  87.                    the concept of _EEEE_TTTT_SSSS_DDDD_UUUU, although it does support the sending
  88.                    of an expedited data stream with no logical boundaries
  89.                    preserved across a connection; a value of -1 specifies that
  90.                    there is no limit on the size of an _EEEE_TTTT_SSSS_DDDD_UUUU; and a value of
  91.                    -2 specifies that the transfer of expedited data is not
  92.                    supported by the transport provider.
  93.  
  94.      _cccc_oooo_nnnn_nnnn_eeee_cccc_tttt       A value greater than or equal to zero specifies the maximum
  95.                    amount of data that may be associated with connection
  96.                    establishment functions; a value of -1 specifies that there
  97.                    is no limit on the amount of data sent during connection
  98.                    establishment; and a value of -2 specifies that the
  99.                    transport provider does not allow data to be sent with
  100.                    connection establishment functions.
  101.  
  102.      _dddd_iiii_ssss_cccc_oooo_nnnn        A value greater than or equal to zero specifies the maximum
  103.                    amount of data that may be associated with the _tttt______ssss_nnnn_dddd_dddd_iiii_ssss and
  104.                    _tttt______rrrr_cccc_vvvv_dddd_iiii_ssss functions; a value of -1 specifies that there is
  105.                    no limit on the amount of data sent with these abortive
  106.                    release functions; and a value of -2 specifies that the
  107.                    transport provider does not allow data to be sent with the
  108.                    abortive release functions.
  109.  
  110.      _ssss_eeee_rrrr_vvvv_tttt_yyyy_pppp_eeee      This field specifies the service type supported by the
  111.                    transport provider, as described below.
  112.  
  113.      _ffff_llll_aaaa_gggg_ssss         If ______XXXX_OOOO_PPPP_EEEE_NNNN______SSSS_OOOO_UUUU_RRRR_CCCC_EEEE is defined, then this structure element
  114.                    will exist.  This is a bit field used to specify other
  115.                    information about the transport provider.  If the
  116.                    T_SENDZERO bit is set in _ffff_llll_aaaa_gggg_ssss, this indicates that the
  117.                    underlying transport provider supports the sending of
  118.                    zero-length TSDUs.  Following is a dicussion of the
  119.                    separate issue of zero-length fragments within a _TTTT_SSSS_DDDD_UUUU.
  120.                    Sending data of zero octets:
  121.  
  122.                    The transport service definition, both in connection-
  123.                    oriented mode and in connectionless mode, does not permit
  124.                    sending a _TTTT_SSSS_DDDD_UUUU of zero octets.  So, in connectionless mode,
  125.                    if the _llll_eeee_nnnn parameter is set to zero, the _tttt______ssss_nnnn_dddd_uuuu_dddd_aaaa_tttt_aaaa() call
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. tttt____ggggeeeettttiiiinnnnffffoooo((((3333NNNN))))                                                    tttt____ggggeeeettttiiiinnnnffffoooo((((3333NNNN))))
  137.  
  138.  
  139.  
  140.                    will always return unsuccessfully with _----_1111 and _tttt______eeee_rrrr_rrrr_nnnn_oooo set
  141.                    to _TTTT_BBBB_AAAA_DDDD_DDDD_AAAA_TTTT_AAAA.  In connection-oriented mode, if the _nnnn_bbbb_yyyy_tttt_eeee_ssss
  142.                    parameter is set to zero, the _tttt______ssss_nnnn_dddd() call will return with
  143.                    _----_1111 and _tttt______eeee_rrrr_rrrr_nnnn_oooo set to _TTTT_BBBB_AAAA_DDDD_DDDD_AAAA_TTTT_AAAA if either the T_MORE flag is
  144.                    set or the T_MORE flag is not set and the preceding _tttt______ssss_nnnn_dddd()
  145.                    call completed a _TTTT_SSSS_DDDD_UUUU or _EEEE_TTTT_SSSS_DDDD_UUUU (that is, the call has
  146.                    requested sending a zero byte _TTTT_SSSS_DDDD_UUUU or _EEEE_TTTT_SSSS_DDDD_UUUU.
  147.  
  148.      If a transport user is concerned with protocol independence, the above
  149.      sizes may be accessed to determine how large the buffers must be to hold
  150.      each piece of information.  Alternatively, the _tttt______aaaa_llll_llll_oooo_cccc function may be
  151.      used to allocate these buffers.  An error will result if a transport user
  152.      exceeds the allowed data size on any function.  The value of each field
  153.      may change as a result of option negotiation, and _tttt______gggg_eeee_tttt_iiii_nnnn_ffff_oooo enables a
  154.      user to retrieve the current characteristics.
  155.  
  156.      The _ssss_eeee_rrrr_vvvv_tttt_yyyy_pppp_eeee field of _iiii_nnnn_ffff_oooo may specify one of the following values on
  157.      return:
  158.  
  159.      _TTTT______CCCC_OOOO_TTTT_SSSS         The transport provider supports a connection-mode service
  160.                     but does not support the optional orderly release
  161.                     facility.
  162.  
  163.      _TTTT______CCCC_OOOO_TTTT_SSSS______OOOO_RRRR_DDDD     The transport provider supports a connection-mode service
  164.                     with the optional orderly release facility.
  165.  
  166.      _TTTT______CCCC_LLLL_TTTT_SSSS         The transport provider supports a connectionless-mode
  167.                     service.  For this service type, _tttt______oooo_pppp_eeee_nnnn will return -2 for
  168.                     _eeee_tttt_ssss_dddd_uuuu, _cccc_oooo_nnnn_nnnn_eeee_cccc_tttt, and _dddd_iiii_ssss_cccc_oooo_nnnn.
  169.  
  170.      This function resides within both the X/Open compliant _llll_iiii_bbbb_xxxx_nnnn_eeee_tttt and the
  171.      SVR4 compliant _llll_iiii_bbbb_nnnn_ssss_llll Network Services libraries.  Network Services
  172.      applications which require X/Open compliance must link-load with _----_llll_xxxx_nnnn_eeee_tttt.
  173.      Network Services applications which require SVR4 compliance must link-
  174.      load with _----_llll_nnnn_ssss_llll.
  175.  
  176.      On failure, _tttt______eeee_rrrr_rrrr_nnnn_oooo may be set to one of the following:
  177.  
  178.      _TTTT_BBBB_AAAA_DDDD_FFFF          The specified file descriptor does not refer to a
  179.                     transport endpoint.
  180.  
  181.      _TTTT_SSSS_YYYY_SSSS_EEEE_RRRR_RRRR        A system error has occurred during execution of this
  182.                     function.
  183.  
  184. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  185.      _tttt______aaaa_llll_llll_oooo_cccc(3N), _tttt______oooo_pppp_eeee_nnnn(3N)
  186.  
  187. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  188.      _tttt______gggg_eeee_tttt_iiii_nnnn_ffff_oooo returns 0 on success and -1 on failure and _tttt______eeee_rrrr_rrrr_nnnn_oooo is set to
  189.      indicate the error.
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.